/*
 * Copyright 2002-2006 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.tigris.jasmincc.framework;

import java.util.*;

/**
 * Coordinates the parse and assembly of different grammars.
 * 
 * @author Sam Huang
 * 
 */
public interface Coordinator {

	/**
	 * Launch a gramar.
	 * 
	 * @param grammarName
	 *            the root grammar name
	 * @return the resulted JavaCC file
	 * @throws Exception
	 */
	JavaCCModel crosscompile(String grammarName) throws Exception;

	/**
	 * Add a new grammar to be processed.
	 * 
	 * @param instanceName
	 *            the instance name of the grammar
	 * @param grammarName
	 *            the grammar name
	 * @param instances
	 *            the initialized parameters
	 */
	void addGrammar(String instanceName, String grammarName,
			Map<String, String> instances);

	/**
	 * Check if the current grammar is the first grammar in the chain.
	 * 
	 * @return true if it is
	 */
	boolean isPrimaryGrammar();
}
